Send shipment documents to a list of email recipients

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

Request Body schema: application/json
required
documents
required
Array of strings <uuid>

List of document ids to attach to email

message
required
string
recipient_emails
required
Array of strings

List of email addresses of recipients

subject
required
string
Responses
200

Task to send emails was properly enqueued to email service

Response Schema: application/json
documents
required
Array of strings <uuid>

List of document ids to attach to email

message
required
string
recipient_emails
required
Array of strings

List of email addresses of recipients

subject
required
string
default

Default error response

post/shipments/{shipmentId}/documents/send/
Request samples
application/json
{
  • "documents": [
    ],
  • "message": "string",
  • "recipient_emails": [
    ],
  • "subject": "string"
}
Response samples
application/json
{
  • "documents": [
    ],
  • "message": "string",
  • "recipient_emails": [
    ],
  • "subject": "string"
}
Copyright © Shipwell 2024. All right reserved.